Skip to content

Conversation

coodos
Copy link
Contributor

@coodos coodos commented Aug 27, 2025

Description of change

fix search

Issue Number

closes #340

Type of change

  • Fix (a change which fixes an issue)

How the change has been tested

Change checklist

  • I have ensured that the CI Checks pass locally
  • I have removed any unnecessary logic
  • My code is well documented
  • I have signed my commits
  • My code follows the pattern of the application
  • I have self reviewed my code

Summary by CodeRabbit

  • New Features

    • Added an authenticated endpoint to search users by English name or name, with optional verified-only filter and pagination (up to 50 results).
  • Improvements

    • Enhanced user search relevance with smarter exact/fuzzy matching and default ranking by relevance, then verification status, then name.
    • Preserved existing sort options (name, verified, newest) with improved consistency.
  • Breaking Changes

    • The existing user search endpoint now returns only the list of users, removing pagination metadata (total/pages) from the response.

Copy link
Contributor

coderabbitai bot commented Aug 27, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Updates user search: modifies existing search response to return only users; adds a new /api/users/search/ename-name endpoint with validation and pagination; enhances service search logic with relevance scoring, exact/fuzzy queries, case-insensitive-style matching, and dedicated ename/name search and count methods; wires new route under auth.

Changes

Cohort / File(s) Summary of Changes
Controller updates
platforms/pictique-api/src/controllers/UserController.ts
Refactors search handler to return only users; adds searchByEnameOrName with input validation, pagination (cap 50), optional verified filter, and error handling.
Service search enhancements
platforms/pictique-api/src/services/UserService.ts
Introduces relevance scoring using exact/fuzzy queries; adjusts default sorting to relevance_score > isVerified > name; exposes searchUsersByEnameOrName and getSearchUsersByEnameOrNameCount; enforces short-query guard and pagination bounds; includes ename in select.
Routing updates
platforms/pictique-api/src/index.ts
Registers authenticated GET /api/users/search/ename-name mapped to UserController.searchByEnameOrName.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant C as Client
  participant R as API Router
  participant A as Auth Middleware
  participant UC as UserController
  participant US as UserService
  participant DB as Database

  C->>R: GET /api/users/search/ename-name?q=...&page=&limit=&verified=
  R->>A: Authenticate request
  A-->>R: OK
  R->>UC: searchByEnameOrName(req,res)
  UC->>UC: Validate q (min 2), parse pagination/verified
  UC->>US: searchUsersByEnameOrName(q, page, limit, verified)
  US->>DB: Query with exact/fuzzy, relevance scoring, filters
  DB-->>US: Rows (users, ename, relevance_score)
  US-->>UC: users[]
  UC-->>C: 200 OK, { users: [...] }
  note over UC,C: Response excludes pagination metadata
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Assessment against linked issues

Objective Addressed Explanation
Fix case sensitivity in Pictique search (#340) Summaries indicate fuzzy/exact matching and relevance changes but do not explicitly confirm case-insensitive matching (e.g., ILIKE).

Assessment against linked issues: Out-of-scope changes

Code Change Explanation
Remove pagination metadata from search response to return only users (platforms/pictique-api/src/controllers/UserController.ts, multiple lines) Altering response shape is not part of the case-sensitivity bug fix objective (#340).
Add new endpoint /api/users/search/ename-name with dedicated logic (platforms/pictique-api/src/controllers/UserController.ts and src/index.ts, multiple lines) A separate feature; not explicitly required by the case-sensitivity bug fix.

Possibly related PRs

  • fix: search #341 — Also reworks user search logic with relevance and fuzzy matching; likely parallel or precursor to this change.

Poem

I twitch my ears at queries’ plight,
From ENAME peaks to names in light—
Fuzzy trails and exact I chase,
Ranking hops with nimble grace.
New burrowed route, a tidy tune,
Users found beneath the moon.
Thump-thump! Search sings in tune. 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between f543b20 and 277a41e.

📒 Files selected for processing (3)
  • platforms/pictique-api/src/controllers/UserController.ts (2 hunks)
  • platforms/pictique-api/src/index.ts (1 hunks)
  • platforms/pictique-api/src/services/UserService.ts (5 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/pictique-search

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coodos coodos merged commit ddafb8f into main Aug 27, 2025
0 of 3 checks passed
@coodos coodos deleted the fix/pictique-search branch August 27, 2025 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Pictique search doesn't work properly
1 participant